API

Human resource APIs

GET human-resources/employees

List of employees. Note that this API can show employees from all companies within the same group, but only the ones where you have the permission ViewEmployees. Employee for current user will always show.

HTTP method GET
URI https://api.rambase.net/human-resources/employees
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 500
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 412, version 26

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ActiveEmployees() Named filter Active employees.
InCurrentDatabase() Named filter Employees in current database
CompanyDatabase String Abbreviation/code to identify the company.
DepartmentId Integer Department identifier.
Email String Email address of the employee.
EmployeeId Integer Employee identifier.
FirstName String First name of employee.
Gender String Gender of the employee.
JobTitle String Job title of employee. Ex. Sales manager.
LaborGroupId Integer Labor group identifier.
LastName String Last name of employee.
Status Integer Status of employee.
SuperiorId Integer Superior of the employee.
Type String Filters on the Type of employee. Type can be employee wirh system access or employee without system access.

Read more about filters and sorting on how to use sortable parameters

CompanyDatabase String Abbreviation/code to identify the company
DepartmentId Integer Department identifier
Email String Email address of the employee
EmployeeId Integer Employee identifier
FirstName String First name of employee
Gender String Gender of the employee
JobTitle String Job title of employee. Ex. Sales manager
LaborGroupId Integer Labor group identifier
LastName String Last name of employee
Status Integer Status of employee
SuperiorId Integer Superior of the employee
Type String Filters on the Type of employee. Type can be employee wirh system access or employee without system access.

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Employees>
2
     <Employee>
3
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
4
          <Status
Status

Status of employee

Possible domain values can be found here

>{Integer}</Status>
5
          <LastName
LastName

Last name of employee

>{String}</LastName>
6
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
7
          <Gender
Gender

Gender of the employee

Possible domain values can be found here

>{String}</Gender>
8
          <JobTitle
JobTitle

Job title of employee. Ex. Sales manager

>{String}</JobTitle>
9
          <Email
Email

Email address of the employee

>{String}</Email>
10
          <Company
Company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

>
11
               <CompanyId
CompanyId

Company identifier

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

>{Integer}</CompanyId>
12
               <Name
Name

Name of company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

>{String}</Name>
13
               <Database
Database

Abbreviation/code to identify the company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

>{String}</Database>
14
               <CompanyLink
CompanyLink

Company reference

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

>{String}</CompanyLink>
15
          </Company>
16
          <Superior
Superior

Superior of the employee

>
17
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
18
               <LastName
LastName

Last name of employee

>{String}</LastName>
19
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
20
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
21
          </Superior>
22
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
23
     </Employee>
24
     <Paging
Paging

Detailed paging information for this list.

>
25
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
26
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
27
          <Page
Page

Page index

>{Integer}</Page>
28
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
29
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
30
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
31
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
32
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
33
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
34
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
35
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
36
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
37
     </Paging>
38
</Employees>
1
{
2
     "employees": [
3
          {
4
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
5
               "status
Status

Status of employee

Possible domain values can be found here

": "{Integer}",
6
               "lastName
LastName

Last name of employee

": "{String}",
7
               "firstName
FirstName

First name of employee

": "{String}",
8
               "gender
Gender

Gender of the employee

Possible domain values can be found here

": "{String}",
9
               "jobTitle
JobTitle

Job title of employee. Ex. Sales manager

": "{String}",
10
               "email
Email

Email address of the employee

": "{String}",
11
               "company
Company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

": {
12
                    "companyId
CompanyId

Company identifier

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

": "{Integer}",
13
                    "name
Name

Name of company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

": "{String}",
14
                    "database
Database

Abbreviation/code to identify the company

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

": "{String}",
15
                    "companyLink
CompanyLink

Company reference

This field is greyed out because it is an expandable field. You have to add $expand=Employee.Company in your request URI to get this field

": "{String}"
16
               },
17
               "superior
Superior

Superior of the employee

": {
18
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
19
                    "lastName
LastName

Last name of employee

": "{String}",
20
                    "firstName
FirstName

First name of employee

": "{String}",
21
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
22
               },
23
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
24
          }
25
     ],
26
     "paging
Paging

Detailed paging information for this list.

": {
27
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
28
          "position
Position

Position of the first element in the list

": "{Integer}",
29
          "page
Page

Page index

": "{Integer}",
30
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
31
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
32
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
33
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
34
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
35
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
36
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
37
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
38
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
39
     }
40
}

Possible error codes the response might return:

Error 101566 HTTP 404 User not found